Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

SDL 0231 Menu Tiles Revision #795

Conversation

Jack-Byrne
Copy link
Contributor

Introduction

This is a revision to remove the default value (defvalue="LIST") from the menuLayout parameter introduced by the original proposal.

Motivation

While testing for regressions SetGlobalProperties the author noticed that including a defvalue in the RPC means that any time that the menuLayout parameter is omitted, the menuLayout would be set to LIST. This is problematic if an app had previously set TILES as the menu layout in a previous SetGlobalProperties Request.

Proposed Solution

In all mentions of menuLayout, the default value should be removed. This applies to SetGlobalProperties and AddSubMenu requests in the mobile and hmi apis.

-    <param name="menuLayout" type="MenuLayout" defvalue="LIST" mandatory="false" since="X.Y">
+    <param name="menuLayout" type="MenuLayout" mandatory="false" since="X.Y">

Potential downsides

No downsides identified with the API change.

Impact on existing code

Core and mobile will need to update their RPC spec implementations to not include or autofill a default parameter for menuLayout.

Alternatives considered

Leave the default value as is. The author does not believe this is an ideal solution.

@Jack-Byrne
Copy link
Contributor Author

@theresalech Ready for review.

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants